Plugin/LineEndingCheck: Add autocrlf warning #260
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
the
impact:non-functional
makubacki
changed the title
makubacki
reviewed
Feb 10, 2023
makubacki
reviewed
Feb 10, 2023
makubacki
reviewed
Feb 10, 2023
makubacki
reviewed
Feb 10, 2023
makubacki
approved these changes
Feb 10, 2023
|
@apop5 I currently have a PR in edk2-pytool-extensions that synchronizes all git commands to use GitPython rather than RunCmd. tianocore/edk2-pytool-extensions#407 Once the edk2-pytool-extensions PR is in and GitPython is installed with the package, then the changes in this PR will need to be updated to something along the lines of the following: r = Repo(workspace_root)
try:
result = r.config_reader().get_value("core", "autocrlf"))
except NoOptionError as e:
pass
# Do something with this error
|
|
@Javagedes I'll wait and update the PR after the edk2-pytool-extensions PR completes, and a release is made and picked up. This or really is meant to be informational, so that a warning is generated. I would see problems trying to change a user's git environment. |
Flickdm
approved these changes
Feb 18, 2023
|
@apop5 you should be able to come back to this now. |
github-actions
bot
added
the
language:python
apop5
force-pushed
the
user/apop5/addwarningtolineending
branch
from
750838e
to
cb1c5f0
Compare
github-actions
bot
removed
the
language:python
|
PR has been updated to use GitPython. |
TaylorBeebe
pushed a commit
to TaylorBeebe/mu_basecore
that referenced
this pull request
Apr 27, 2023
# Preface Please ensure you have read the [contribution docs](https://github.com/microsoft/mu/blob/master/CONTRIBUTING.md) prior to submitting the pull request. In particular, [pull request guidelines](https://github.com/microsoft/mu/blob/master/CONTRIBUTING.md#pull-request-best-practices). ## Description LineEndingCheck's ReadMe.md recommends that autocrlf=false, but developers may not have configured their system with this setting. This change generates a warning message when it determines that the autocrlf does not match the recommended setting. For each item, place an "x" in between `[` and `]` if true. Example: `[x]`. _(you can also check items in the GitHub UI)_ - [ ] Impacts functionality? - **Functionality** - Does the change ultimately impact how firmware functions? - Examples: Add a new library, publish a new PPI, update an algorithm, ... - [ ] Impacts security? - **Security** - Does the change have a direct security impact on an application, flow, or firmware? - Examples: Crypto algorithm change, buffer overflow fix, parameter validation improvement, ... - [ ] Breaking change? - **Breaking change** - Will anyone consuming this change experience a break in build or boot behavior? - Examples: Add a new library class, move a module to a different repo, call a function in a new library class in a pre-existing module, ... - [ ] Includes tests? - **Tests** - Does the change include any explicit test code? - Examples: Unit tests, integration tests, robot tests, ... - [ ] Includes documentation? - **Documentation** - Does the change contain explicit documentation additions outside direct code modifications (and comments)? - Examples: Update readme file, add feature readme file, link to documentation on an a separate Web page, ... ## How This Was Tested Testing by configuring a system with `git config --global core.autocrlf true` and running a CI build to verify message is displayed, then by configuring `git config --global core.autocrlf false` and running a CI build to verify warning message is not displayed. Tested when no core.autocrlf is is set (deleting from config file). ## Integration Instructions n/a
kenlautner
pushed a commit
that referenced
this pull request
Apr 28, 2023
# Preface Please ensure you have read the [contribution docs](https://github.com/microsoft/mu/blob/master/CONTRIBUTING.md) prior to submitting the pull request. In particular, [pull request guidelines](https://github.com/microsoft/mu/blob/master/CONTRIBUTING.md#pull-request-best-practices). ## Description LineEndingCheck's ReadMe.md recommends that autocrlf=false, but developers may not have configured their system with this setting. This change generates a warning message when it determines that the autocrlf does not match the recommended setting. For each item, place an "x" in between `[` and `]` if true. Example: `[x]`. _(you can also check items in the GitHub UI)_ - [ ] Impacts functionality? - **Functionality** - Does the change ultimately impact how firmware functions? - Examples: Add a new library, publish a new PPI, update an algorithm, ... - [ ] Impacts security? - **Security** - Does the change have a direct security impact on an application, flow, or firmware? - Examples: Crypto algorithm change, buffer overflow fix, parameter validation improvement, ... - [ ] Breaking change? - **Breaking change** - Will anyone consuming this change experience a break in build or boot behavior? - Examples: Add a new library class, move a module to a different repo, call a function in a new library class in a pre-existing module, ... - [ ] Includes tests? - **Tests** - Does the change include any explicit test code? - Examples: Unit tests, integration tests, robot tests, ... - [ ] Includes documentation? - **Documentation** - Does the change contain explicit documentation additions outside direct code modifications (and comments)? - Examples: Update readme file, add feature readme file, link to documentation on an a separate Web page, ... ## How This Was Tested Testing by configuring a system with `git config --global core.autocrlf true` and running a CI build to verify message is displayed, then by configuring `git config --global core.autocrlf false` and running a CI build to verify warning message is not displayed. Tested when no core.autocrlf is is set (deleting from config file). ## Integration Instructions n/a
kenlautner
pushed a commit
that referenced
this pull request
May 3, 2023
# Preface Please ensure you have read the [contribution docs](https://github.com/microsoft/mu/blob/master/CONTRIBUTING.md) prior to submitting the pull request. In particular, [pull request guidelines](https://github.com/microsoft/mu/blob/master/CONTRIBUTING.md#pull-request-best-practices). ## Description LineEndingCheck's ReadMe.md recommends that autocrlf=false, but developers may not have configured their system with this setting. This change generates a warning message when it determines that the autocrlf does not match the recommended setting. For each item, place an "x" in between `[` and `]` if true. Example: `[x]`. _(you can also check items in the GitHub UI)_ - [ ] Impacts functionality? - **Functionality** - Does the change ultimately impact how firmware functions? - Examples: Add a new library, publish a new PPI, update an algorithm, ... - [ ] Impacts security? - **Security** - Does the change have a direct security impact on an application, flow, or firmware? - Examples: Crypto algorithm change, buffer overflow fix, parameter validation improvement, ... - [ ] Breaking change? - **Breaking change** - Will anyone consuming this change experience a break in build or boot behavior? - Examples: Add a new library class, move a module to a different repo, call a function in a new library class in a pre-existing module, ... - [ ] Includes tests? - **Tests** - Does the change include any explicit test code? - Examples: Unit tests, integration tests, robot tests, ... - [ ] Includes documentation? - **Documentation** - Does the change contain explicit documentation additions outside direct code modifications (and comments)? - Examples: Update readme file, add feature readme file, link to documentation on an a separate Web page, ... ## How This Was Tested Testing by configuring a system with `git config --global core.autocrlf true` and running a CI build to verify message is displayed, then by configuring `git config --global core.autocrlf false` and running a CI build to verify warning message is not displayed. Tested when no core.autocrlf is is set (deleting from config file). ## Integration Instructions n/a
kenlautner
pushed a commit
that referenced
this pull request
May 4, 2023
# Preface Please ensure you have read the [contribution docs](https://github.com/microsoft/mu/blob/master/CONTRIBUTING.md) prior to submitting the pull request. In particular, [pull request guidelines](https://github.com/microsoft/mu/blob/master/CONTRIBUTING.md#pull-request-best-practices). ## Description LineEndingCheck's ReadMe.md recommends that autocrlf=false, but developers may not have configured their system with this setting. This change generates a warning message when it determines that the autocrlf does not match the recommended setting. For each item, place an "x" in between `[` and `]` if true. Example: `[x]`. _(you can also check items in the GitHub UI)_ - [ ] Impacts functionality? - **Functionality** - Does the change ultimately impact how firmware functions? - Examples: Add a new library, publish a new PPI, update an algorithm, ... - [ ] Impacts security? - **Security** - Does the change have a direct security impact on an application, flow, or firmware? - Examples: Crypto algorithm change, buffer overflow fix, parameter validation improvement, ... - [ ] Breaking change? - **Breaking change** - Will anyone consuming this change experience a break in build or boot behavior? - Examples: Add a new library class, move a module to a different repo, call a function in a new library class in a pre-existing module, ... - [ ] Includes tests? - **Tests** - Does the change include any explicit test code? - Examples: Unit tests, integration tests, robot tests, ... - [ ] Includes documentation? - **Documentation** - Does the change contain explicit documentation additions outside direct code modifications (and comments)? - Examples: Update readme file, add feature readme file, link to documentation on an a separate Web page, ... ## How This Was Tested Testing by configuring a system with `git config --global core.autocrlf true` and running a CI build to verify message is displayed, then by configuring `git config --global core.autocrlf false` and running a CI build to verify warning message is not displayed. Tested when no core.autocrlf is is set (deleting from config file). ## Integration Instructions n/a
kenlautner
pushed a commit
that referenced
this pull request
May 4, 2023
# Preface Please ensure you have read the [contribution docs](https://github.com/microsoft/mu/blob/master/CONTRIBUTING.md) prior to submitting the pull request. In particular, [pull request guidelines](https://github.com/microsoft/mu/blob/master/CONTRIBUTING.md#pull-request-best-practices). ## Description LineEndingCheck's ReadMe.md recommends that autocrlf=false, but developers may not have configured their system with this setting. This change generates a warning message when it determines that the autocrlf does not match the recommended setting. For each item, place an "x" in between `[` and `]` if true. Example: `[x]`. _(you can also check items in the GitHub UI)_ - [ ] Impacts functionality? - **Functionality** - Does the change ultimately impact how firmware functions? - Examples: Add a new library, publish a new PPI, update an algorithm, ... - [ ] Impacts security? - **Security** - Does the change have a direct security impact on an application, flow, or firmware? - Examples: Crypto algorithm change, buffer overflow fix, parameter validation improvement, ... - [ ] Breaking change? - **Breaking change** - Will anyone consuming this change experience a break in build or boot behavior? - Examples: Add a new library class, move a module to a different repo, call a function in a new library class in a pre-existing module, ... - [ ] Includes tests? - **Tests** - Does the change include any explicit test code? - Examples: Unit tests, integration tests, robot tests, ... - [ ] Includes documentation? - **Documentation** - Does the change contain explicit documentation additions outside direct code modifications (and comments)? - Examples: Update readme file, add feature readme file, link to documentation on an a separate Web page, ... ## How This Was Tested Testing by configuring a system with `git config --global core.autocrlf true` and running a CI build to verify message is displayed, then by configuring `git config --global core.autocrlf false` and running a CI build to verify warning message is not displayed. Tested when no core.autocrlf is is set (deleting from config file). ## Integration Instructions n/a
kenlautner
pushed a commit
that referenced
this pull request
May 5, 2023
Makes the following changes: 1. Recursively discovers files in packages instead of just checking the top-level package directory. The pattern should recursively find files relative to the package which accomplished with `**` in this change. 2. Differentiates between binary and text files, skipping line ending checks in binary files. 3. Verifies a path discovered is a file. Directories may rarely contain a dot in the name appearing in the path result list. 4. For files with issues, print the relative file path to the workspace. This is less than verbose than absolute, unique enough to find the file, and recognized for shortcut clicking in IDEs like VS Code. 5. For files with issues, print the relative file path to the file in POSIX format (with forward slashes). This makes copy/ paste easy to tools like unixtodos and is equally recognized as a valid file path in IDEs like VS Code on Windows. Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com> .pytool/Plugin/LineEndingCheck: Add git ignore support Adds support to ignore git ignored files and files under submodules since those are either addressed in their respective repo's CI or from an external project. Some optimizations are also made to improve performance. As the comment in the code states, these changes call the system git command until GitPython is more widely used in the edk2 tool modules. Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com> Plugin/LineEndingCheck: Add autocrlf warning (#260) LineEndingCheck's ReadMe.md recommends that autocrlf=false, but developers may not have configured their system with this setting. This change generates a warning message when it determines that the autocrlf does not match the recommended setting. For each item, place an "x" in between `[` and `]` if true. Example: `[x]`. _(you can also check items in the GitHub UI)_ - [ ] Impacts functionality? - **Functionality** - Does the change ultimately impact how firmware functions? - Examples: Add a new library, publish a new PPI, update an algorithm, ... - [ ] Impacts security? - **Security** - Does the change have a direct security impact on an application, flow, or firmware? - Examples: Crypto algorithm change, buffer overflow fix, parameter validation improvement, ... - [ ] Breaking change? - **Breaking change** - Will anyone consuming this change experience a break in build or boot behavior? - Examples: Add a new library class, move a module to a different repo, call a function in a new library class in a pre-existing module, ... - [ ] Includes tests? - **Tests** - Does the change include any explicit test code? - Examples: Unit tests, integration tests, robot tests, ... - [ ] Includes documentation? - **Documentation** - Does the change contain explicit documentation additions outside direct code modifications (and comments)? - Examples: Update readme file, add feature readme file, link to documentation on an a separate Web page, ... Testing by configuring a system with `git config --global core.autocrlf true` and running a CI build to verify message is displayed, then by configuring `git config --global core.autocrlf false` and running a CI build to verify warning message is not displayed. Tested when no core.autocrlf is is set (deleting from config file). n/a
kenlautner
pushed a commit
that referenced
this pull request
May 5, 2023
Makes the following changes: 1. Recursively discovers files in packages instead of just checking the top-level package directory. The pattern should recursively find files relative to the package which accomplished with `**` in this change. 2. Differentiates between binary and text files, skipping line ending checks in binary files. 3. Verifies a path discovered is a file. Directories may rarely contain a dot in the name appearing in the path result list. 4. For files with issues, print the relative file path to the workspace. This is less than verbose than absolute, unique enough to find the file, and recognized for shortcut clicking in IDEs like VS Code. 5. For files with issues, print the relative file path to the file in POSIX format (with forward slashes). This makes copy/ paste easy to tools like unixtodos and is equally recognized as a valid file path in IDEs like VS Code on Windows. Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com> .pytool/Plugin/LineEndingCheck: Add git ignore support Adds support to ignore git ignored files and files under submodules since those are either addressed in their respective repo's CI or from an external project. Some optimizations are also made to improve performance. As the comment in the code states, these changes call the system git command until GitPython is more widely used in the edk2 tool modules. Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com> Plugin/LineEndingCheck: Add autocrlf warning (#260) LineEndingCheck's ReadMe.md recommends that autocrlf=false, but developers may not have configured their system with this setting. This change generates a warning message when it determines that the autocrlf does not match the recommended setting. For each item, place an "x" in between `[` and `]` if true. Example: `[x]`. _(you can also check items in the GitHub UI)_ - [ ] Impacts functionality? - **Functionality** - Does the change ultimately impact how firmware functions? - Examples: Add a new library, publish a new PPI, update an algorithm, ... - [ ] Impacts security? - **Security** - Does the change have a direct security impact on an application, flow, or firmware? - Examples: Crypto algorithm change, buffer overflow fix, parameter validation improvement, ... - [ ] Breaking change? - **Breaking change** - Will anyone consuming this change experience a break in build or boot behavior? - Examples: Add a new library class, move a module to a different repo, call a function in a new library class in a pre-existing module, ... - [ ] Includes tests? - **Tests** - Does the change include any explicit test code? - Examples: Unit tests, integration tests, robot tests, ... - [ ] Includes documentation? - **Documentation** - Does the change contain explicit documentation additions outside direct code modifications (and comments)? - Examples: Update readme file, add feature readme file, link to documentation on an a separate Web page, ... Testing by configuring a system with `git config --global core.autocrlf true` and running a CI build to verify message is displayed, then by configuring `git config --global core.autocrlf false` and running a CI build to verify warning message is not displayed. Tested when no core.autocrlf is is set (deleting from config file). n/a
kenlautner
pushed a commit
that referenced
this pull request
May 9, 2023
Makes the following changes: 1. Recursively discovers files in packages instead of just checking the top-level package directory. The pattern should recursively find files relative to the package which accomplished with `**` in this change. 2. Differentiates between binary and text files, skipping line ending checks in binary files. 3. Verifies a path discovered is a file. Directories may rarely contain a dot in the name appearing in the path result list. 4. For files with issues, print the relative file path to the workspace. This is less than verbose than absolute, unique enough to find the file, and recognized for shortcut clicking in IDEs like VS Code. 5. For files with issues, print the relative file path to the file in POSIX format (with forward slashes). This makes copy/ paste easy to tools like unixtodos and is equally recognized as a valid file path in IDEs like VS Code on Windows. Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com> .pytool/Plugin/LineEndingCheck: Add git ignore support Adds support to ignore git ignored files and files under submodules since those are either addressed in their respective repo's CI or from an external project. Some optimizations are also made to improve performance. As the comment in the code states, these changes call the system git command until GitPython is more widely used in the edk2 tool modules. Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com> Plugin/LineEndingCheck: Add autocrlf warning (#260) LineEndingCheck's ReadMe.md recommends that autocrlf=false, but developers may not have configured their system with this setting. This change generates a warning message when it determines that the autocrlf does not match the recommended setting. For each item, place an "x" in between `[` and `]` if true. Example: `[x]`. _(you can also check items in the GitHub UI)_ - [ ] Impacts functionality? - **Functionality** - Does the change ultimately impact how firmware functions? - Examples: Add a new library, publish a new PPI, update an algorithm, ... - [ ] Impacts security? - **Security** - Does the change have a direct security impact on an application, flow, or firmware? - Examples: Crypto algorithm change, buffer overflow fix, parameter validation improvement, ... - [ ] Breaking change? - **Breaking change** - Will anyone consuming this change experience a break in build or boot behavior? - Examples: Add a new library class, move a module to a different repo, call a function in a new library class in a pre-existing module, ... - [ ] Includes tests? - **Tests** - Does the change include any explicit test code? - Examples: Unit tests, integration tests, robot tests, ... - [ ] Includes documentation? - **Documentation** - Does the change contain explicit documentation additions outside direct code modifications (and comments)? - Examples: Update readme file, add feature readme file, link to documentation on an a separate Web page, ... Testing by configuring a system with `git config --global core.autocrlf true` and running a CI build to verify message is displayed, then by configuring `git config --global core.autocrlf false` and running a CI build to verify warning message is not displayed. Tested when no core.autocrlf is is set (deleting from config file). n/a
kenlautner
pushed a commit
that referenced
this pull request
Oct 17, 2023
Makes the following changes: 1. Recursively discovers files in packages instead of just checking the top-level package directory. The pattern should recursively find files relative to the package which accomplished with `**` in this change. 2. Differentiates between binary and text files, skipping line ending checks in binary files. 3. Verifies a path discovered is a file. Directories may rarely contain a dot in the name appearing in the path result list. 4. For files with issues, print the relative file path to the workspace. This is less than verbose than absolute, unique enough to find the file, and recognized for shortcut clicking in IDEs like VS Code. 5. For files with issues, print the relative file path to the file in POSIX format (with forward slashes). This makes copy/ paste easy to tools like unixtodos and is equally recognized as a valid file path in IDEs like VS Code on Windows. Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com> .pytool/Plugin/LineEndingCheck: Add git ignore support Adds support to ignore git ignored files and files under submodules since those are either addressed in their respective repo's CI or from an external project. Some optimizations are also made to improve performance. As the comment in the code states, these changes call the system git command until GitPython is more widely used in the edk2 tool modules. Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com> Plugin/LineEndingCheck: Add autocrlf warning (#260) LineEndingCheck's ReadMe.md recommends that autocrlf=false, but developers may not have configured their system with this setting. This change generates a warning message when it determines that the autocrlf does not match the recommended setting. For each item, place an "x" in between `[` and `]` if true. Example: `[x]`. _(you can also check items in the GitHub UI)_ - [ ] Impacts functionality? - **Functionality** - Does the change ultimately impact how firmware functions? - Examples: Add a new library, publish a new PPI, update an algorithm, ... - [ ] Impacts security? - **Security** - Does the change have a direct security impact on an application, flow, or firmware? - Examples: Crypto algorithm change, buffer overflow fix, parameter validation improvement, ... - [ ] Breaking change? - **Breaking change** - Will anyone consuming this change experience a break in build or boot behavior? - Examples: Add a new library class, move a module to a different repo, call a function in a new library class in a pre-existing module, ... - [ ] Includes tests? - **Tests** - Does the change include any explicit test code? - Examples: Unit tests, integration tests, robot tests, ... - [ ] Includes documentation? - **Documentation** - Does the change contain explicit documentation additions outside direct code modifications (and comments)? - Examples: Update readme file, add feature readme file, link to documentation on an a separate Web page, ... Testing by configuring a system with `git config --global core.autocrlf true` and running a CI build to verify message is displayed, then by configuring `git config --global core.autocrlf false` and running a CI build to verify warning message is not displayed. Tested when no core.autocrlf is is set (deleting from config file). n/a
kenlautner
pushed a commit
that referenced
this pull request
Oct 18, 2023
Makes the following changes: 1. Recursively discovers files in packages instead of just checking the top-level package directory. The pattern should recursively find files relative to the package which accomplished with `**` in this change. 2. Differentiates between binary and text files, skipping line ending checks in binary files. 3. Verifies a path discovered is a file. Directories may rarely contain a dot in the name appearing in the path result list. 4. For files with issues, print the relative file path to the workspace. This is less than verbose than absolute, unique enough to find the file, and recognized for shortcut clicking in IDEs like VS Code. 5. For files with issues, print the relative file path to the file in POSIX format (with forward slashes). This makes copy/ paste easy to tools like unixtodos and is equally recognized as a valid file path in IDEs like VS Code on Windows. Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com> .pytool/Plugin/LineEndingCheck: Add git ignore support Adds support to ignore git ignored files and files under submodules since those are either addressed in their respective repo's CI or from an external project. Some optimizations are also made to improve performance. As the comment in the code states, these changes call the system git command until GitPython is more widely used in the edk2 tool modules. Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com> Plugin/LineEndingCheck: Add autocrlf warning (#260) LineEndingCheck's ReadMe.md recommends that autocrlf=false, but developers may not have configured their system with this setting. This change generates a warning message when it determines that the autocrlf does not match the recommended setting. For each item, place an "x" in between `[` and `]` if true. Example: `[x]`. _(you can also check items in the GitHub UI)_ - [ ] Impacts functionality? - **Functionality** - Does the change ultimately impact how firmware functions? - Examples: Add a new library, publish a new PPI, update an algorithm, ... - [ ] Impacts security? - **Security** - Does the change have a direct security impact on an application, flow, or firmware? - Examples: Crypto algorithm change, buffer overflow fix, parameter validation improvement, ... - [ ] Breaking change? - **Breaking change** - Will anyone consuming this change experience a break in build or boot behavior? - Examples: Add a new library class, move a module to a different repo, call a function in a new library class in a pre-existing module, ... - [ ] Includes tests? - **Tests** - Does the change include any explicit test code? - Examples: Unit tests, integration tests, robot tests, ... - [ ] Includes documentation? - **Documentation** - Does the change contain explicit documentation additions outside direct code modifications (and comments)? - Examples: Update readme file, add feature readme file, link to documentation on an a separate Web page, ... Testing by configuring a system with `git config --global core.autocrlf true` and running a CI build to verify message is displayed, then by configuring `git config --global core.autocrlf false` and running a CI build to verify warning message is not displayed. Tested when no core.autocrlf is is set (deleting from config file). n/a
kenlautner
pushed a commit
that referenced
this pull request
Oct 18, 2023
Makes the following changes: 1. Recursively discovers files in packages instead of just checking the top-level package directory. The pattern should recursively find files relative to the package which accomplished with `**` in this change. 2. Differentiates between binary and text files, skipping line ending checks in binary files. 3. Verifies a path discovered is a file. Directories may rarely contain a dot in the name appearing in the path result list. 4. For files with issues, print the relative file path to the workspace. This is less than verbose than absolute, unique enough to find the file, and recognized for shortcut clicking in IDEs like VS Code. 5. For files with issues, print the relative file path to the file in POSIX format (with forward slashes). This makes copy/ paste easy to tools like unixtodos and is equally recognized as a valid file path in IDEs like VS Code on Windows. Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com> .pytool/Plugin/LineEndingCheck: Add git ignore support Adds support to ignore git ignored files and files under submodules since those are either addressed in their respective repo's CI or from an external project. Some optimizations are also made to improve performance. As the comment in the code states, these changes call the system git command until GitPython is more widely used in the edk2 tool modules. Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com> Plugin/LineEndingCheck: Add autocrlf warning (#260) LineEndingCheck's ReadMe.md recommends that autocrlf=false, but developers may not have configured their system with this setting. This change generates a warning message when it determines that the autocrlf does not match the recommended setting. For each item, place an "x" in between `[` and `]` if true. Example: `[x]`. _(you can also check items in the GitHub UI)_ - [ ] Impacts functionality? - **Functionality** - Does the change ultimately impact how firmware functions? - Examples: Add a new library, publish a new PPI, update an algorithm, ... - [ ] Impacts security? - **Security** - Does the change have a direct security impact on an application, flow, or firmware? - Examples: Crypto algorithm change, buffer overflow fix, parameter validation improvement, ... - [ ] Breaking change? - **Breaking change** - Will anyone consuming this change experience a break in build or boot behavior? - Examples: Add a new library class, move a module to a different repo, call a function in a new library class in a pre-existing module, ... - [ ] Includes tests? - **Tests** - Does the change include any explicit test code? - Examples: Unit tests, integration tests, robot tests, ... - [ ] Includes documentation? - **Documentation** - Does the change contain explicit documentation additions outside direct code modifications (and comments)? - Examples: Update readme file, add feature readme file, link to documentation on an a separate Web page, ... Testing by configuring a system with `git config --global core.autocrlf true` and running a CI build to verify message is displayed, then by configuring `git config --global core.autocrlf false` and running a CI build to verify warning message is not displayed. Tested when no core.autocrlf is is set (deleting from config file). n/a
kenlautner
pushed a commit
that referenced
this pull request
Oct 20, 2023
Makes the following changes: 1. Recursively discovers files in packages instead of just checking the top-level package directory. The pattern should recursively find files relative to the package which accomplished with `**` in this change. 2. Differentiates between binary and text files, skipping line ending checks in binary files. 3. Verifies a path discovered is a file. Directories may rarely contain a dot in the name appearing in the path result list. 4. For files with issues, print the relative file path to the workspace. This is less than verbose than absolute, unique enough to find the file, and recognized for shortcut clicking in IDEs like VS Code. 5. For files with issues, print the relative file path to the file in POSIX format (with forward slashes). This makes copy/ paste easy to tools like unixtodos and is equally recognized as a valid file path in IDEs like VS Code on Windows. Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com> .pytool/Plugin/LineEndingCheck: Add git ignore support Adds support to ignore git ignored files and files under submodules since those are either addressed in their respective repo's CI or from an external project. Some optimizations are also made to improve performance. As the comment in the code states, these changes call the system git command until GitPython is more widely used in the edk2 tool modules. Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com> Plugin/LineEndingCheck: Add autocrlf warning (#260) LineEndingCheck's ReadMe.md recommends that autocrlf=false, but developers may not have configured their system with this setting. This change generates a warning message when it determines that the autocrlf does not match the recommended setting. For each item, place an "x" in between `[` and `]` if true. Example: `[x]`. _(you can also check items in the GitHub UI)_ - [ ] Impacts functionality? - **Functionality** - Does the change ultimately impact how firmware functions? - Examples: Add a new library, publish a new PPI, update an algorithm, ... - [ ] Impacts security? - **Security** - Does the change have a direct security impact on an application, flow, or firmware? - Examples: Crypto algorithm change, buffer overflow fix, parameter validation improvement, ... - [ ] Breaking change? - **Breaking change** - Will anyone consuming this change experience a break in build or boot behavior? - Examples: Add a new library class, move a module to a different repo, call a function in a new library class in a pre-existing module, ... - [ ] Includes tests? - **Tests** - Does the change include any explicit test code? - Examples: Unit tests, integration tests, robot tests, ... - [ ] Includes documentation? - **Documentation** - Does the change contain explicit documentation additions outside direct code modifications (and comments)? - Examples: Update readme file, add feature readme file, link to documentation on an a separate Web page, ... Testing by configuring a system with `git config --global core.autocrlf true` and running a CI build to verify message is displayed, then by configuring `git config --global core.autocrlf false` and running a CI build to verify warning message is not displayed. Tested when no core.autocrlf is is set (deleting from config file). n/a
kenlautner
pushed a commit
that referenced
this pull request
Oct 23, 2023
Makes the following changes: 1. Recursively discovers files in packages instead of just checking the top-level package directory. The pattern should recursively find files relative to the package which accomplished with `**` in this change. 2. Differentiates between binary and text files, skipping line ending checks in binary files. 3. Verifies a path discovered is a file. Directories may rarely contain a dot in the name appearing in the path result list. 4. For files with issues, print the relative file path to the workspace. This is less than verbose than absolute, unique enough to find the file, and recognized for shortcut clicking in IDEs like VS Code. 5. For files with issues, print the relative file path to the file in POSIX format (with forward slashes). This makes copy/ paste easy to tools like unixtodos and is equally recognized as a valid file path in IDEs like VS Code on Windows. Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com> .pytool/Plugin/LineEndingCheck: Add git ignore support Adds support to ignore git ignored files and files under submodules since those are either addressed in their respective repo's CI or from an external project. Some optimizations are also made to improve performance. As the comment in the code states, these changes call the system git command until GitPython is more widely used in the edk2 tool modules. Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com> Plugin/LineEndingCheck: Add autocrlf warning (#260) LineEndingCheck's ReadMe.md recommends that autocrlf=false, but developers may not have configured their system with this setting. This change generates a warning message when it determines that the autocrlf does not match the recommended setting. For each item, place an "x" in between `[` and `]` if true. Example: `[x]`. _(you can also check items in the GitHub UI)_ - [ ] Impacts functionality? - **Functionality** - Does the change ultimately impact how firmware functions? - Examples: Add a new library, publish a new PPI, update an algorithm, ... - [ ] Impacts security? - **Security** - Does the change have a direct security impact on an application, flow, or firmware? - Examples: Crypto algorithm change, buffer overflow fix, parameter validation improvement, ... - [ ] Breaking change? - **Breaking change** - Will anyone consuming this change experience a break in build or boot behavior? - Examples: Add a new library class, move a module to a different repo, call a function in a new library class in a pre-existing module, ... - [ ] Includes tests? - **Tests** - Does the change include any explicit test code? - Examples: Unit tests, integration tests, robot tests, ... - [ ] Includes documentation? - **Documentation** - Does the change contain explicit documentation additions outside direct code modifications (and comments)? - Examples: Update readme file, add feature readme file, link to documentation on an a separate Web page, ... Testing by configuring a system with `git config --global core.autocrlf true` and running a CI build to verify message is displayed, then by configuring `git config --global core.autocrlf false` and running a CI build to verify warning message is not displayed. Tested when no core.autocrlf is is set (deleting from config file). n/a
kenlautner
pushed a commit
that referenced
this pull request
Dec 16, 2023
Makes the following changes: 1. Recursively discovers files in packages instead of just checking the top-level package directory. The pattern should recursively find files relative to the package which accomplished with `**` in this change. 2. Differentiates between binary and text files, skipping line ending checks in binary files. 3. Verifies a path discovered is a file. Directories may rarely contain a dot in the name appearing in the path result list. 4. For files with issues, print the relative file path to the workspace. This is less than verbose than absolute, unique enough to find the file, and recognized for shortcut clicking in IDEs like VS Code. 5. For files with issues, print the relative file path to the file in POSIX format (with forward slashes). This makes copy/ paste easy to tools like unixtodos and is equally recognized as a valid file path in IDEs like VS Code on Windows. Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com> .pytool/Plugin/LineEndingCheck: Add git ignore support Adds support to ignore git ignored files and files under submodules since those are either addressed in their respective repo's CI or from an external project. Some optimizations are also made to improve performance. As the comment in the code states, these changes call the system git command until GitPython is more widely used in the edk2 tool modules. Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com> Plugin/LineEndingCheck: Add autocrlf warning (#260) LineEndingCheck's ReadMe.md recommends that autocrlf=false, but developers may not have configured their system with this setting. This change generates a warning message when it determines that the autocrlf does not match the recommended setting. For each item, place an "x" in between `[` and `]` if true. Example: `[x]`. _(you can also check items in the GitHub UI)_ - [ ] Impacts functionality? - **Functionality** - Does the change ultimately impact how firmware functions? - Examples: Add a new library, publish a new PPI, update an algorithm, ... - [ ] Impacts security? - **Security** - Does the change have a direct security impact on an application, flow, or firmware? - Examples: Crypto algorithm change, buffer overflow fix, parameter validation improvement, ... - [ ] Breaking change? - **Breaking change** - Will anyone consuming this change experience a break in build or boot behavior? - Examples: Add a new library class, move a module to a different repo, call a function in a new library class in a pre-existing module, ... - [ ] Includes tests? - **Tests** - Does the change include any explicit test code? - Examples: Unit tests, integration tests, robot tests, ... - [ ] Includes documentation? - **Documentation** - Does the change contain explicit documentation additions outside direct code modifications (and comments)? - Examples: Update readme file, add feature readme file, link to documentation on an a separate Web page, ... Testing by configuring a system with `git config --global core.autocrlf true` and running a CI build to verify message is displayed, then by configuring `git config --global core.autocrlf false` and running a CI build to verify warning message is not displayed. Tested when no core.autocrlf is is set (deleting from config file). n/a
kenlautner
pushed a commit
that referenced
this pull request
Dec 18, 2023
Makes the following changes: 1. Recursively discovers files in packages instead of just checking the top-level package directory. The pattern should recursively find files relative to the package which accomplished with `**` in this change. 2. Differentiates between binary and text files, skipping line ending checks in binary files. 3. Verifies a path discovered is a file. Directories may rarely contain a dot in the name appearing in the path result list. 4. For files with issues, print the relative file path to the workspace. This is less than verbose than absolute, unique enough to find the file, and recognized for shortcut clicking in IDEs like VS Code. 5. For files with issues, print the relative file path to the file in POSIX format (with forward slashes). This makes copy/ paste easy to tools like unixtodos and is equally recognized as a valid file path in IDEs like VS Code on Windows. Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com> .pytool/Plugin/LineEndingCheck: Add git ignore support Adds support to ignore git ignored files and files under submodules since those are either addressed in their respective repo's CI or from an external project. Some optimizations are also made to improve performance. As the comment in the code states, these changes call the system git command until GitPython is more widely used in the edk2 tool modules. Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com> Plugin/LineEndingCheck: Add autocrlf warning (#260) LineEndingCheck's ReadMe.md recommends that autocrlf=false, but developers may not have configured their system with this setting. This change generates a warning message when it determines that the autocrlf does not match the recommended setting. For each item, place an "x" in between `[` and `]` if true. Example: `[x]`. _(you can also check items in the GitHub UI)_ - [ ] Impacts functionality? - **Functionality** - Does the change ultimately impact how firmware functions? - Examples: Add a new library, publish a new PPI, update an algorithm, ... - [ ] Impacts security? - **Security** - Does the change have a direct security impact on an application, flow, or firmware? - Examples: Crypto algorithm change, buffer overflow fix, parameter validation improvement, ... - [ ] Breaking change? - **Breaking change** - Will anyone consuming this change experience a break in build or boot behavior? - Examples: Add a new library class, move a module to a different repo, call a function in a new library class in a pre-existing module, ... - [ ] Includes tests? - **Tests** - Does the change include any explicit test code? - Examples: Unit tests, integration tests, robot tests, ... - [ ] Includes documentation? - **Documentation** - Does the change contain explicit documentation additions outside direct code modifications (and comments)? - Examples: Update readme file, add feature readme file, link to documentation on an a separate Web page, ... Testing by configuring a system with `git config --global core.autocrlf true` and running a CI build to verify message is displayed, then by configuring `git config --global core.autocrlf false` and running a CI build to verify warning message is not displayed. Tested when no core.autocrlf is is set (deleting from config file). n/a
kenlautner
pushed a commit
to kenlautner/mu_basecore
that referenced
this pull request
Jun 19, 2024
Makes the following changes: 1. Recursively discovers files in packages instead of just checking the top-level package directory. The pattern should recursively find files relative to the package which accomplished with `**` in this change. 2. Differentiates between binary and text files, skipping line ending checks in binary files. 3. Verifies a path discovered is a file. Directories may rarely contain a dot in the name appearing in the path result list. 4. For files with issues, print the relative file path to the workspace. This is less than verbose than absolute, unique enough to find the file, and recognized for shortcut clicking in IDEs like VS Code. 5. For files with issues, print the relative file path to the file in POSIX format (with forward slashes). This makes copy/ paste easy to tools like unixtodos and is equally recognized as a valid file path in IDEs like VS Code on Windows. Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com> .pytool/Plugin/LineEndingCheck: Add git ignore support Adds support to ignore git ignored files and files under submodules since those are either addressed in their respective repo's CI or from an external project. Some optimizations are also made to improve performance. As the comment in the code states, these changes call the system git command until GitPython is more widely used in the edk2 tool modules. Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com> Plugin/LineEndingCheck: Add autocrlf warning (microsoft#260) LineEndingCheck's ReadMe.md recommends that autocrlf=false, but developers may not have configured their system with this setting. This change generates a warning message when it determines that the autocrlf does not match the recommended setting. For each item, place an "x" in between `[` and `]` if true. Example: `[x]`. _(you can also check items in the GitHub UI)_ - [ ] Impacts functionality? - **Functionality** - Does the change ultimately impact how firmware functions? - Examples: Add a new library, publish a new PPI, update an algorithm, ... - [ ] Impacts security? - **Security** - Does the change have a direct security impact on an application, flow, or firmware? - Examples: Crypto algorithm change, buffer overflow fix, parameter validation improvement, ... - [ ] Breaking change? - **Breaking change** - Will anyone consuming this change experience a break in build or boot behavior? - Examples: Add a new library class, move a module to a different repo, call a function in a new library class in a pre-existing module, ... - [ ] Includes tests? - **Tests** - Does the change include any explicit test code? - Examples: Unit tests, integration tests, robot tests, ... - [ ] Includes documentation? - **Documentation** - Does the change contain explicit documentation additions outside direct code modifications (and comments)? - Examples: Update readme file, add feature readme file, link to documentation on an a separate Web page, ... Testing by configuring a system with `git config --global core.autocrlf true` and running a CI build to verify message is displayed, then by configuring `git config --global core.autocrlf false` and running a CI build to verify warning message is not displayed. Tested when no core.autocrlf is is set (deleting from config file). n/a
kenlautner
pushed a commit
to kenlautner/mu_basecore
that referenced
this pull request
Jun 21, 2024
Makes the following changes: 1. Recursively discovers files in packages instead of just checking the top-level package directory. The pattern should recursively find files relative to the package which accomplished with `**` in this change. 2. Differentiates between binary and text files, skipping line ending checks in binary files. 3. Verifies a path discovered is a file. Directories may rarely contain a dot in the name appearing in the path result list. 4. For files with issues, print the relative file path to the workspace. This is less than verbose than absolute, unique enough to find the file, and recognized for shortcut clicking in IDEs like VS Code. 5. For files with issues, print the relative file path to the file in POSIX format (with forward slashes). This makes copy/ paste easy to tools like unixtodos and is equally recognized as a valid file path in IDEs like VS Code on Windows. Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com> .pytool/Plugin/LineEndingCheck: Add git ignore support Adds support to ignore git ignored files and files under submodules since those are either addressed in their respective repo's CI or from an external project. Some optimizations are also made to improve performance. As the comment in the code states, these changes call the system git command until GitPython is more widely used in the edk2 tool modules. Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com> Plugin/LineEndingCheck: Add autocrlf warning (microsoft#260) LineEndingCheck's ReadMe.md recommends that autocrlf=false, but developers may not have configured their system with this setting. This change generates a warning message when it determines that the autocrlf does not match the recommended setting. For each item, place an "x" in between `[` and `]` if true. Example: `[x]`. _(you can also check items in the GitHub UI)_ - [ ] Impacts functionality? - **Functionality** - Does the change ultimately impact how firmware functions? - Examples: Add a new library, publish a new PPI, update an algorithm, ... - [ ] Impacts security? - **Security** - Does the change have a direct security impact on an application, flow, or firmware? - Examples: Crypto algorithm change, buffer overflow fix, parameter validation improvement, ... - [ ] Breaking change? - **Breaking change** - Will anyone consuming this change experience a break in build or boot behavior? - Examples: Add a new library class, move a module to a different repo, call a function in a new library class in a pre-existing module, ... - [ ] Includes tests? - **Tests** - Does the change include any explicit test code? - Examples: Unit tests, integration tests, robot tests, ... - [ ] Includes documentation? - **Documentation** - Does the change contain explicit documentation additions outside direct code modifications (and comments)? - Examples: Update readme file, add feature readme file, link to documentation on an a separate Web page, ... Testing by configuring a system with `git config --global core.autocrlf true` and running a CI build to verify message is displayed, then by configuring `git config --global core.autocrlf false` and running a CI build to verify warning message is not displayed. Tested when no core.autocrlf is is set (deleting from config file). n/a
kenlautner
pushed a commit
to kenlautner/mu_basecore
that referenced
this pull request
Jun 22, 2024
Makes the following changes: 1. Recursively discovers files in packages instead of just checking the top-level package directory. The pattern should recursively find files relative to the package which accomplished with `**` in this change. 2. Differentiates between binary and text files, skipping line ending checks in binary files. 3. Verifies a path discovered is a file. Directories may rarely contain a dot in the name appearing in the path result list. 4. For files with issues, print the relative file path to the workspace. This is less than verbose than absolute, unique enough to find the file, and recognized for shortcut clicking in IDEs like VS Code. 5. For files with issues, print the relative file path to the file in POSIX format (with forward slashes). This makes copy/ paste easy to tools like unixtodos and is equally recognized as a valid file path in IDEs like VS Code on Windows. Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com> .pytool/Plugin/LineEndingCheck: Add git ignore support Adds support to ignore git ignored files and files under submodules since those are either addressed in their respective repo's CI or from an external project. Some optimizations are also made to improve performance. As the comment in the code states, these changes call the system git command until GitPython is more widely used in the edk2 tool modules. Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com> Plugin/LineEndingCheck: Add autocrlf warning (microsoft#260) LineEndingCheck's ReadMe.md recommends that autocrlf=false, but developers may not have configured their system with this setting. This change generates a warning message when it determines that the autocrlf does not match the recommended setting. For each item, place an "x" in between `[` and `]` if true. Example: `[x]`. _(you can also check items in the GitHub UI)_ - [ ] Impacts functionality? - **Functionality** - Does the change ultimately impact how firmware functions? - Examples: Add a new library, publish a new PPI, update an algorithm, ... - [ ] Impacts security? - **Security** - Does the change have a direct security impact on an application, flow, or firmware? - Examples: Crypto algorithm change, buffer overflow fix, parameter validation improvement, ... - [ ] Breaking change? - **Breaking change** - Will anyone consuming this change experience a break in build or boot behavior? - Examples: Add a new library class, move a module to a different repo, call a function in a new library class in a pre-existing module, ... - [ ] Includes tests? - **Tests** - Does the change include any explicit test code? - Examples: Unit tests, integration tests, robot tests, ... - [ ] Includes documentation? - **Documentation** - Does the change contain explicit documentation additions outside direct code modifications (and comments)? - Examples: Update readme file, add feature readme file, link to documentation on an a separate Web page, ... Testing by configuring a system with `git config --global core.autocrlf true` and running a CI build to verify message is displayed, then by configuring `git config --global core.autocrlf false` and running a CI build to verify warning message is not displayed. Tested when no core.autocrlf is is set (deleting from config file). n/a
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Preface
Please ensure you have read the contribution docs prior
to submitting the pull request. In particular,
pull request guidelines.
Description
LineEndingCheck's ReadMe.md recommends that autocrlf=false, but developers may not have configured their system with this setting. This change generates a warning message when it determines that the autocrlf does not match the recommended setting.
For each item, place an "x" in between
[and]if true. Example:[x].(you can also check items in the GitHub UI)
flow, or firmware?
validation improvement, ...
in build or boot behavior?
a function in a new library class in a pre-existing module, ...
outside direct code modifications (and comments)?
on an a separate Web page, ...
How This Was Tested
Testing by configuring a system with
git config --global core.autocrlf trueand running a CI build to verify message is displayed, then by configuringgit config --global core.autocrlf falseand running a CI build to verify warning message is not displayed.Tested when no core.autocrlf is is set (deleting from config file).
Integration Instructions
n/a